charger24.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef CHARGER24_H
#define CHARGER24_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"




#define CHARGER24_STATE_NO_INPUT        0
#define CHARGER24_STATE_CHARGING        1
#define CHARGER24_STATE_CHARGE_DONE     2
 // charger24_set



#define CHARGER24_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.iok = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.dsb = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.dis = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.stat = MIKROBUS( mikrobus, MIKROBUS_INT )
 // charger24_map // charger24

typedef struct
{
    digital_out_t dsb;          
    digital_out_t dis;          
 
    digital_in_t iok;           
    digital_in_t stat;          
 
} charger24_t;

typedef struct
{
    pin_name_t iok;             
    pin_name_t dsb;             
    pin_name_t dis;             
    pin_name_t stat;            
 
} charger24_cfg_t;

typedef enum
{
    CHARGER24_OK = 0,
    CHARGER24_ERROR = -1
 
} charger24_return_value_t;


void charger24_cfg_setup ( charger24_cfg_t *cfg );

err_t charger24_init ( charger24_t *ctx, charger24_cfg_t *cfg );

void charger24_enable_boost ( charger24_t *ctx );

void charger24_disable_boost ( charger24_t *ctx );

void charger24_enable_charging ( charger24_t *ctx );

void charger24_disable_charging ( charger24_t *ctx );

uint8_t charger24_get_stat_pin ( charger24_t *ctx );

uint8_t charger24_get_iok_pin ( charger24_t *ctx );

uint8_t charger24_get_status ( charger24_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CHARGER24_H
 // charger24
 
// ------------------------------------------------------------------------ END